PDS Mini Services
Domain Message Specification

getPatientDetailsResponse-v1-0 Tabular View

Static model: getPatientDetailsResponse-v1-0 - COMT_RM000016GB01

Date: 08 June 2011 15:17:56 BST
getPatientDetailsResponse-v1-0
Used by:
classCode: CS [1..1] {M = OBS} Indicates that this is an Observation.
moodCode: CS [1..1] {M = EVN} Indicates that this is an Event.
id: II.NHS.IdentifierType2 [1..1] {M}

This is the unique identifier of the Act.

The II.NHS.IdentifierType2 data type flavour is used to carry the identifier as follows:

  • The root attribute shall contain a DCE UUID
code: CV.NHS.CodedValueType1 [1..1] {M = C:MiniServiceMessageType#getPatientDetailsResponse-v1-0}

A code which indicates the type of message.

The CV.NHS.CodedValueType1 data type flavour is used to carry the information as follows:

  • The code attribute is fixed to the value indicated.
  • The codeSystem attribute shall contain the OID for the vocabulary indicated
value: CV.NHS.CodedValueType1 [1..1] {M < V:PDSMiniServiceResponseCode CNE} { CNE:PDSMiniServiceResponseCode }

A code which indicates the type of response.

The CV.NHS.CodedValueType1 data type flavour is used to carry the information as follows:

  • The code attribute shall be populated with a concept taken from the vocabulary shown.
  • The codeSystem attribute shall contain the OID for the vocabulary indicated
subject 0..1 {U} ()

[0..*]
Used by:
getPatientDetailsResponse-v1-0
Information about the Subject.
typeCode: CS [1..1] {M = SBJ} Indicates that this is a Subject.
patient 1..1 {U} (Patient)

Patient
Used by: getPatientDetailsResponse-v1-0
Information about the Patient.
classCode: CS [1..1] {M = PAT} Indicates that this is a Patient.
id: II [1..2] {M}

The value of the identifier for the patient.

The first II shall contain the NHS Number using the II.NHS.IdentifierType1 datatype flavour to carry this information as follows:

  • The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.4.1";
  • The extension attribute will contain the NHS number itself.

The second II shall contain a local identifier using the II.NHS.IdentifierType3 datatype flavour to carry this information as follows:

  • The root attribute will contain an OID.
  • The extension attribute will contain the local identifier itself.
In the absence of a local OID, the OID 2.16.840.1.113883.2.1.3.2.4.18.24 (Local Person Identifier) may be used.
name: PN.NHS.PersonNameType2 [0..1] {U} The name of the patient.

The PN.NHS.PersonNameType2 data type flavour is used to carry this information as follows:

  • The prefix element may be used to carry the prefix (e.g. title)
  • The family element may be used to carry the family name.
  • The given element may be used to carry the given name.

Additionally, the use attribute should be populated with "L" for the usual name.

addr: AD.NHS.AddressType2 [0..3] {U}

The address of the patient.

The AD.NHS.AddressType2 data type flavour shall be used to carry this information as follows:

  • Five streetAddressLine elements must be present and carry the address.
  • The postalCode element may be used to carry the postcode.
telecom: TEL [0..*] {U} Telecommunication addresses of the patient.

This attribute is used to carry telephone addresses, e-mails etc.
patientPerson 0..1 {U} (Person)

Person
Used by: Patient

Information about the Person.

classCode: CS [1..1] {M = PSN}

Indicates that this is a Person.

determinerCode: CS [1..1] {M = INSTANCE}

Indicates that this is an instance.

administrativeGenderCode: CV.NHS.CodedValueType1 [0..1] {U < V:Sex CNE} { CNE:Sex }

A code which indicates the gender.

The CV data type is used to carry the information as follows:

  • The code attribute shall be populated with a concept taken from the vocabulary shown.
  • The codeSystem attribute shall contain the OID for the vocabulary indicated
birthTime: TS.NHS.TimestampType3 [0..1] {U} The date of birth for the patient.

The TS.NHS.TimestampType3 data type flavour will be used to carry this information as follows:

  • The value attribute will carry the date in the format YYYYMMDD or YYYYMM.
deceasedTime: TS.NHS.TimestampType1 [0..1] {U} The date of death of the patient.

The TS.NHS.TimestampType1 data type flavour will be used to carry this information as follows:

  • The value attribute will carry the date in the format YYYYMMDD.
gPPractice 0..1 {U} (GPPractice)

GPPractice
Used by: Person
Information about the GPPractice.
classCode: CS [1..1] {M = SDLOC} Indicates that this is a Service Delivery Location.
addr: AD.NHS.AddressType2 [0..1] {U}

The address of the GP Practice.

The AD.NHS.AddressType2 data type flavour shall be used to carry this information as follows:

  • Five streetAddressLine elements must be present and carry the address.
  • The postalCode element may be used to carry the postcode.
telecom: TEL [0..1] {U}

Telecommunication address of the GP Practice.

locationOrganization 0..1 {U} (Organization)

Organization
Used by: GPPractice
Information about the Organisation.
classCode: CS [1..1] {M = ORG} Indicates that this is an Organisation.
determinerCode: CS [1..1] {M = INSTANCE} Indicates that this is an instance.
id: II.NHS.IdentifierType3 [0..1] {U} The identifier of the Organisation.
name: ON [0..1] {U} The name of the organisation.